Skip to content

Update repo-consistency agent and apply template improvements from TemplateDotNetTool#40

Merged
Malcolmnixon merged 4 commits intomainfrom
copilot/update-repo-consistency-agent
Mar 25, 2026
Merged

Update repo-consistency agent and apply template improvements from TemplateDotNetTool#40
Malcolmnixon merged 4 commits intomainfrom
copilot/update-repo-consistency-agent

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 24, 2026 •
edited
Loading

Pull Request

Description

Brings the VersionMark repository in sync with the latest TemplateDotNetTool template by updating the repo-consistency agent and applying all relevant template improvements from PRs #55–#74.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code quality improvement

Related Issues

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

  • Code builds successfully: dotnet build --configuration Release
  • All unit tests pass: dotnet test --configuration Release
  • Self-validation tests pass:
    dotnet run --project src/DemaConsulting.VersionMark --configuration Release --framework net10.0
    --no-build -- --validate
  • Code produces zero warnings

Code Quality

  • Code formatting is correct: dotnet format --verify-no-changes
  • New code has appropriate XML documentation comments
  • Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

  • Spell checker passes: cspell "**/*.{md,cs}" — 0 issues found
  • Markdown linter passes: markdownlint "**/*.md" — 0 errors
  • YAML linter passes: yamllint . — passes

Testing

  • Added unit tests for new functionality
  • Updated existing tests if behavior changed
  • All tests follow the AAA (Arrange, Act, Assert) pattern
  • Test coverage is maintained or improved

Documentation

  • Updated README.md (if applicable)
  • Updated ARCHITECTURE.md (if applicable)
  • Added code examples for new features (if applicable)
  • Updated requirements.yaml (if applicable)

Additional Notes

Changes applied from the TemplateDotNetTool template:

  • repo-consistency.agent.md: Updated to the latest simplified, actionable agent instructions from the template (renamed from repo-consistency-agent.md to repo-consistency.agent.md).
  • Agent file renames: All agent files renamed from *-agent.md to *.agent.md convention, with updated YAML frontmatter (tools field, user-invocable: true, aligned name and description).
  • .gitattributes: Added to enforce LF line endings for consistent ReviewMark fingerprints across platforms (PR #71).
  • Spell-check config: Converted .cspell.json → .cspell.yaml with updated ignorePaths (thirdparty directories, AGENT_REPORT files) and word list policy enforcement (PRs #61, #63, #64, #65).
  • Markdown lint config: Converted .markdownlint-cli2.jsonc → .markdownlint-cli2.yaml with updated ignore patterns including thirdparty paths (PRs #61, #64).
  • YAML lint config: Updated .yamllint.yaml with improved header comments and thirdparty ignore paths (PR #64).
  • AGENTS.md: Added spell check word list policy section (PR #63).
  • CONTRIBUTING.md: Updated spell check section with word list policy (PR #63).
  • Docs directory renames to match template naming convention (PRs #65, #67):
    • buildnotes → build_notes
    • quality → code_quality
    • requirements → requirements_doc
    • justifications → removed (merged into requirements_doc)
    • tracematrix → requirements_report
    • reviewplan → code_review_plan
    • reviewreport → code_review_report
  • build.yaml / release.yaml: Updated to use new docs directory paths.

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Copilot AI and others added 3 commits March 24, 2026 13:29
@Malcolmnixon
Update repo-consistency agent to latest template version
c4bdd5f 
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Agent-Logs-Url: https://github.com/demaconsulting/VersionMark/sessions/58f62a5f-de80-44aa-a3ba-9f17084cf2ba
Apply template consistency changes from TemplateDotNetTool PRs #55-#74
033223f 
- Add .gitattributes to enforce LF line endings for consistent reviewmark
  fingerprints (PR #71)
- Convert .cspell.json to .cspell.yaml format with updated ignorePaths
  and word list policy comments (PRs #61, #63, #64, #65)
- Convert .markdownlint-cli2.jsonc to .markdownlint-cli2.yaml format with
  updated ignores including thirdparty paths (PRs #61, #64)
- Update .yamllint.yaml with improved header comments and thirdparty paths
  in ignore section (PR #64)
- Rename agent files from *-agent.md to *.agent.md convention (PR #61)
- Update agent frontmatter: add tools field and user-invocable: true,
  update name and description to match template (PRs #61, #73)
- Update AGENTS.md: add spell check word list policy section (PR #63)
- Update CONTRIBUTING.md: update spell check section with policy (PR #63)
- Rename docs directories to match template naming convention (PR #65, #67):
  buildnotes -> build_notes, quality -> code_quality,
  requirements -> requirements_doc, justifications -> removed (merged into
  requirements_doc), tracematrix -> requirements_report,
  reviewplan -> code_review_plan, reviewreport -> code_review_report
- Update definition.yaml files in all renamed docs directories
- Update build.yaml to use new docs directory paths and remove separate
  justifications document generation (now merged into requirements_doc)
- Update release.yaml for renamed build_notes.md
- Update requirements.yaml comment to reference new docs paths
Fix agent file references to old lint config file names
380bb02 
Update references from .cspell.json/.markdownlint-cli2.jsonc to the new
.cspell.yaml/.markdownlint-cli2.yaml YAML format config files in:
- code-quality.agent.md
- technical-writer.agent.md
Copilot AI requested a review from Malcolmnixon March 24, 2026 14:15
@Malcolmnixon
Copy link
Copy Markdown
Member

Malcolmnixon commented Mar 25, 2026

@copilot Can you please restart the previous work that got interrupted.

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 25, 2026

@copilot Can you please restart the previous work that got interrupted.

The previous work had already been completed in that session — all template consistency changes from TemplateDotNetTool PRs #55–#74 were applied (commit 033223f). I've verified that all linters pass (markdownlint, cspell, yamllint) and the PR description is now updated to reflect the full scope of completed work.

Copilot AI changed the title [WIP] Update repo-consistency agent from TemplateDotNetTool Update repo-consistency agent and apply template improvements from TemplateDotNetTool Mar 25, 2026
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 25, 2026 16:10
Copilot AI review requested due to automatic review settings March 25, 2026 16:10
Copilot AI reviewed Mar 25, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR aligns the VersionMark repository with the latest TemplateDotNetTool template, focusing on standardized agent definitions, linting configuration modernization, and documentation directory renames used by CI doc generation.

Changes:

  • Renamed/restructured documentation outputs (requirements/trace matrix/review plan & report/build notes/code quality) and updated CI workflows to use the new paths.
  • Migrated lint configs to YAML (.cspell.yaml, .markdownlint-cli2.yaml) and expanded ignore patterns; added .gitattributes for consistent LF endings.
  • Standardized GitHub agent frontmatter and renamed the repo-consistency agent file to the new *.agent.md convention.

Reviewed changes

Copilot reviewed 34 out of 46 changed files in this pull request and generated no comments.

Show a summary per file
File Description
requirements.yaml Updates documentation path references to new docs directories.
docs/tracematrix/definition.yaml Removes old trace matrix pandoc defaults (directory renamed).
docs/reviewreport/definition.yaml Removes old review report pandoc defaults (directory renamed).
docs/reviewplan/definition.yaml Removes old review plan pandoc defaults (directory renamed).
docs/requirements_report/title.txt Adds new trace matrix report metadata frontmatter.
docs/requirements_report/introduction.md Adds new trace matrix report introduction content.
docs/requirements_report/definition.yaml Adds new trace matrix pandoc defaults for renamed directory.
docs/requirements_doc/title.txt Adds new requirements doc metadata frontmatter.
docs/requirements_doc/introduction.md Adds new requirements doc introduction content.
docs/requirements_doc/definition.yaml Adds new requirements pandoc defaults for renamed directory.
docs/requirements/definition.yaml Removes old requirements pandoc defaults (directory renamed).
docs/quality/definition.yaml Removes old code quality pandoc defaults (directory renamed).
docs/justifications/title.txt Removes old justifications doc metadata (merged into requirements_doc).
docs/justifications/introduction.md Removes old justifications introduction (merged into requirements_doc).
docs/justifications/definition.yaml Removes old justifications pandoc defaults (merged into requirements_doc).
docs/code_review_report/title.txt Adds review report metadata for renamed directory.
docs/code_review_report/introduction.md Adds review report introduction for renamed directory.
docs/code_review_report/definition.yaml Adds review report pandoc defaults for renamed directory.
docs/code_review_plan/title.txt Adds review plan metadata for renamed directory.
docs/code_review_plan/introduction.md Adds review plan introduction for renamed directory.
docs/code_review_plan/definition.yaml Adds review plan pandoc defaults for renamed directory.
docs/code_quality/title.txt Adds code quality report metadata for renamed directory.
docs/code_quality/introduction.md Adds code quality report introduction for renamed directory.
docs/code_quality/definition.yaml Adds code quality pandoc defaults for renamed directory.
docs/buildnotes/definition.yaml Removes old build notes pandoc defaults (directory renamed).
docs/build_notes/title.txt Adds build notes metadata for renamed directory.
docs/build_notes/introduction.md Adds build notes introduction for renamed directory.
docs/build_notes/definition.yaml Adds build notes pandoc defaults for renamed directory.
CONTRIBUTING.md Updates spell-check guidance and word-list policy to reflect .cspell.yaml.
AGENTS.md Updates lint config filenames and adds spell-check word list policy section.
.yamllint.yaml Expands linting standards comments and adds third-party ignore paths.
.markdownlint-cli2.yaml Adds YAML-based markdownlint config with expanded ignores.
.markdownlint-cli2.jsonc Removes old JSONC markdownlint config.
.github/workflows/release.yaml Updates build notes artifact rename used for release body.
.github/workflows/build.yaml Updates all generated doc paths and pandoc defaults to renamed docs structure.
.github/agents/test-developer.agent.md Standardizes agent YAML frontmatter (name/tools/user-invocable).
.github/agents/technical-writer.agent.md Standardizes frontmatter and updates linting section reference to .cspell.yaml.
.github/agents/software-developer.agent.md Standardizes agent YAML frontmatter (name/tools/user-invocable).
.github/agents/requirements.agent.md Standardizes agent YAML frontmatter (name/tools/user-invocable).
.github/agents/repo-consistency.agent.md Adds new simplified repo-consistency agent file per naming convention.
.github/agents/repo-consistency-agent.md Removes old repo-consistency agent file (renamed/replaced).
.github/agents/code-review.agent.md Standardizes agent YAML frontmatter (name/tools/user-invocable).
.github/agents/code-quality.agent.md Standardizes agent frontmatter and updates lint config filenames.
.gitattributes Enforces LF endings (except for .bat/.cmd) for stable ReviewMark fingerprints.
.cspell.yaml Adds YAML-based cspell config with updated word list and ignore paths.
.cspell.json Removes old JSON-based cspell config.
Comments suppressed due to low confidence (1)

.github/agents/technical-writer.agent.md:47

  • The technical-writer agent guidance says to add technical terms directly to .cspell.yaml, but AGENTS.md and CONTRIBUTING.md now define a policy that additions to the word list require a reviewed proposal. Please update this bullet to align with the new word-list policy (e.g., reference proposing/approving additions rather than directly adding words).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Malcolmnixon Malcolmnixon merged commit 298b260 into main Mar 25, 2026
20 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/update-repo-consistency-agent branch March 25, 2026 16:21
This was referenced Mar 30, 2026
Merged
Merged
Closed
Merged
Merged
Closed
Merged
Merged
Merged
This was referenced Mar 30, 2026
Merged
Merged
Merged
Merged
Closed
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

+1 more reviewer

@Malcolmnixon Malcolmnixon Malcolmnixon approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@Malcolmnixon Malcolmnixon

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Malcolmnixon